Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pluralName to gItems to allow the proper spelling when multiple items are received at once #4001

Merged
merged 12 commits into from
Jan 16, 2024

Conversation

pkmnsnfrn
Copy link
Collaborator

@pkmnsnfrn pkmnsnfrn commented Jan 15, 2024

Reminder: add @GraionDilach to the changelog credits for this PR

Description

Brendan receiving multiple of a special plural item

  • Adds special handling for items with names with special plural forms.

Usage

This feature does not require any explicit usage from the player or developer. When the player picks up an item with a special pluralized name, this script will automatically use that name.

New Items

If a new item is added to the game and it should have a special plural form, when adding the item to gItems, pluralName should be defined on the struct for that item.

Testing

Clean Branch

You can recreate this branch by pulling the repo.

git remote add psf-expansion https://github.com/PokemonSanFran/pokeemerald-expansion/ ; git pull psf-expansion plural_item_exceptions

Manual Tests

To recreate my testing environment, you can either:

Download

wget https://github.com/PokemonSanFran/pokeemerald-expansion/raw/6fbe52373039091c3f01caca0ae64bcabcb59080/pokeemerald.sav ; wget https://raw.githubusercontent.com/PokemonSanFran/pokeemerald-expansion/6fbe52373039091c3f01caca0ae64bcabcb59080/data/scripts/debug.inc -O data/scripts/debug.inc

Manually Apply

Verified Scenarios

Each item in the following lists goes to a timestamped YouTube link with each specific scenario being tested.

Discord Contact Info

I am pkmnsnfrn. I have already started a discussion thread.

include/item.h Outdated Show resolved Hide resolved
src/data/items.h Outdated Show resolved Hide resolved
src/item.c Outdated Show resolved Hide resolved
@pkmnsnfrn
Copy link
Collaborator Author

pkmnsnfrn commented Jan 15, 2024

here's what needs to be done:

steps

  1. open the spreadsheet
  2. find the item listed in Column A in src/data/items.h
  3. Add a new field for that item called .pluralName. Populate this value with the corresponding "plural" column value on the spreadsheet. There is an example on ITEM_DEEP_SEA_TOOTH.

I do not think should block the merging of this PR, this work can absolutely come later

I spent about an hour trying to automate this and ran into some problems

  • not all names match (Tera Shards)
  • not all items are even in expansion
  • I am a fraud and don't actually know python

so if nobody picks this up by the time I'm back at my desktop with a real keyboard (in a few weeks), I will do it myself then.

EDIT: It looks like somebody is willing to do it https://discord.com/channels/419213663107416084/1193434690321911828/1196509391357235231

EDIT: this is done.

include/constants/global.h Outdated Show resolved Hide resolved
src/item.c Outdated Show resolved Hide resolved
@Bassoonian Bassoonian merged commit cdf7190 into rh-hideout:upcoming Jan 16, 2024
1 check passed
@pkmnsnfrn pkmnsnfrn deleted the plural_item_exceptions branch April 20, 2024 04:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants